DOCSP-37056 eloquent relationships #2747

ccho-mongodb · 2024-03-05T16:27:15Z

JIRA:
https://jira.mongodb.org/browse/DOCSP-37056

Staging:

Eloquent Models Landing Page
Eloquent Models Relationships

Notes for reviewers:

Most of the content is located in docs/eloquent-models/relationships.txt.
This is the 2nd of 3 PRs on Eloquent Models. The 1st is in this PR and the 3rd (Schema Builder) is covered by https://jira.mongodb.org/browse/DOCSP-37057

Checklist

Add tests and ensure they pass
Add an entry to the CHANGELOG.md file
Update documentation for new features

rustagir

a few small things but good work on this challenging material!

rustagir · 2024-03-05T21:28:24Z

docs/eloquent-models.txt

+Eloquent models are part of the Laravel Eloquent object-relational
+mapping (ORM) framework that enable you to work with a database by using


S: the "that enable" is ambiguous

Suggested change

Eloquent models are part of the Laravel Eloquent object-relational

mapping (ORM) framework that enable you to work with a database by using

Eloquent models are part of the Laravel Eloquent object-relational

mapping (ORM) framework. These models enable you to work with a database by using

Good catch!
I'll use a slightly different structure than suggested since it's the framework rather than the models that relate to the second part.

docs/eloquent-models.txt

docs/eloquent-models/relationships.txt

rustagir · 2024-03-06T15:01:58Z

docs/eloquent-models/relationships.txt

+
+To learn more about many to many relationships in Laravel, see
+`Many to Many <https://laravel.com/docs/{+laravel-docs-version+}/eloquent-relationships#many-to-many>`__
+in the Laravel docs.


Suggested change

in the Laravel docs.

in the Laravel documentation.

rustagir · 2024-03-06T15:02:07Z

docs/eloquent-models/relationships.txt

+
+To learn more about one to many relationships, see
+`One to Many <https://laravel.com/docs/{+laravel-docs-version+}/eloquent-relationships#one-to-many>`__
+in the Laravel docs.


Suggested change

in the Laravel docs.

in the Laravel documentation.

docs/eloquent-models/relationships.txt

rustagir · 2024-03-06T15:02:54Z

docs/eloquent-models/relationships.txt

+the parent model instead of keeping foreign key references. This pattern
+when you must optimize for one or more of the following requirements:


Suggested change

the parent model instead of keeping foreign key references. This pattern

when you must optimize for one or more of the following requirements:

the parent model instead of keeping foreign key references. This pattern

is useful if you must optimize for one or more of the following requirements:

Thanks for catching the grammar issue. I think I forgot to change "This" -> "Use this". Rephrasing slightly to match the related fix.

rustagir · 2024-03-06T15:03:35Z

docs/eloquent-models/relationships.txt

+- Keep associated data together in a single collection
+- Perform atomic updates on multiple fields of the document and the associated
+  data
+- Reduce the number of reads required to fetch the data


S: based on the way the introduction to this list ends, I think you should change the format of these items

Suggested change

- Keep associated data together in a single collection

- Perform atomic updates on multiple fields of the document and the associated

data

- Reduce the number of reads required to fetch the data

- You must keep associated data together in a single collection

- You must perform atomic updates on multiple fields of the document and the associated

data

- You must reduce the number of reads required to fetch the data

Good idea. I decided to convert the verb to a noun by using the gerund.
I think this agrees better with the list introduction.

rustagir

A few small things but approving - re-request review if you feel it's necessary!

rustagir · 2024-03-07T15:57:53Z

docs/eloquent-models/relationships.txt

+The following example class shows how to define a ``HasOne`` one to one
+relationship between a ``Planet`` and ``Orbit`` model.


S: this code example intro and the following one refer to different parts of the code to refer to the relationship as HasOne vs by the method belongsTo(). Perhaps standardize these to either refer to the relationship or the method that creates the relationship?

Good catch, will standardize.

rustagir · 2024-03-07T16:05:32Z

docs/eloquent-models/relationships.txt

+
+A many to many relationship consists of a relationship between two different
+model types in which one type of model record can be related to multiple
+records of the other type.


S: clarify that this relationship applies to both models

Suggested change

records of the other type.

records of the other type and (vice versa or something like that).

rustagir · 2024-03-07T16:06:46Z

docs/eloquent-models/relationships.txt

+The following section shows an example of how to create a many to many
+relationship between model classes.


S: concision

Suggested change

The following section shows an example of how to create a many to many

relationship between model classes.

The following examples demonstrates how to create a many to many

relationship between model classes.

Thanks for pointing this out, will use the standardized version (referenced in this comment) instead.

rustagir · 2024-03-07T16:09:24Z

docs/eloquent-models/relationships.txt

+   :dedent:
+
+The following sample code shows how ton instantiate a model for each class
+and add the relationship between them.  Click the :guilabel:`View Output`


nit: View Output capitalization does not match the GUI VIEW OUTPUT

Suggested change

and add the relationship between them. Click the :guilabel:`View Output`

and add the relationship between them. Click the :guilabel:`View Output`

rustagir · 2024-03-07T16:12:00Z

docs/eloquent-models/relationships.txt

+The following example class shows how to define an ``embedsMany`` one to many
+relationship between a ``SpaceShip`` and ``Cargo`` model:


S; related to earlier comment - decide on a convention to describe this relationship.

Suggested change

The following example class shows how to define an ``embedsMany`` one to many

relationship between a ``SpaceShip`` and ``Cargo`` model:

The following example class shows how to define an ``EmbedsMany`` one to many

relationship between a ``SpaceShip`` and ``Cargo`` model:

Or

Suggested change

The following example class shows how to define an ``embedsMany`` one to many

relationship between a ``SpaceShip`` and ``Cargo`` model:

The following example class shows how to use the ``embedsMany()`` method to define a one to many

relationship between a ``SpaceShip`` and ``Cargo`` model:

Using the standardized version mentioned in this comment.

rustagir · 2024-03-07T16:14:48Z

docs/includes/eloquent-models/relationships/RelationshipController.php

+        $spaceship->name = 'The Millenium Falcon';
+        $spaceship->save();
+
+        $cargoSpice = new Cargo();
+        $cargoSpice->name = 'spice';


Mixing fictions!

Or fictions colliding!

rustagir

reapproving!

GromNaN

We can consider adding unit tests to doc example, that's something do for PHPLIB: https://github.com/mongodb/mongo-php-library/blob/master/tests/DocumentationExamplesTest.php

docs/includes/eloquent-models/relationships/RelationshipController.php

GromNaN

Don't forget to squash on merge.

* DOCSP-37056: Eloquent relationships

Chris Cho added 13 commits February 23, 2024 10:35

DOCSP-37056: Eloquent relationships

ef774e2

WIP

28737cd

one to one

49bcdef

rst fixes

d6d874e

one to many

8228f51

add missing files

6875660

WIP

cca3c56

rst fixes

f7ec772

fix RST

d2bbc98

fix

6d0ba9b

fixes

389c76a

fixes

b82c2ee

update toc title and sample code wording

9dc003e

ccho-mongodb changed the base branch from 4.2 to 4.1 March 5, 2024 16:27

Chris Cho added 4 commits March 5, 2024 11:28

Merge branch '4.1' into DOCSP-37056-eloquent-relationships

d978897

toctree fix

5dbd387

remove install ToC entry

f5dbc6a

show correct code snippet

70310ef

rustagir requested changes Mar 6, 2024

View reviewed changes

Chris Cho added 7 commits March 6, 2024 15:32

PRR fixes

8430d1c

remove stray text

6f2ea84

add tip on schema

65e9648

add right nav and update wording in overview

d8609e9

code snippet fixes

b8b54dd

code linter fixes

2c0526f

remove unnecessary linebreaks

d66b4e5

rustagir previously approved these changes Mar 7, 2024

View reviewed changes

PRR fixes

1da6c33

ccho-mongodb dismissed rustagir’s stale review via 1da6c33 March 7, 2024 21:40

PRR and grammar fixes

945882b

ccho-mongodb marked this pull request as ready for review March 7, 2024 22:10

ccho-mongodb requested a review from a team as a code owner March 7, 2024 22:10

ccho-mongodb requested a review from GromNaN March 7, 2024 22:10

rustagir self-requested a review March 7, 2024 22:13

rustagir previously approved these changes Mar 7, 2024

View reviewed changes

GromNaN approved these changes Mar 11, 2024

View reviewed changes

GromNaN requested changes Mar 14, 2024

View reviewed changes

docs/includes/eloquent-models/relationships/RelationshipController.php Outdated Show resolved Hide resolved

docs/includes/eloquent-models/relationships/RelationshipController.php Outdated Show resolved Hide resolved

GromNaN mentioned this pull request Mar 14, 2024

PHPORM-160 Add tests to documentation examples #2775

Merged

3 tasks

PRR fixes

22419ac

ccho-mongodb dismissed rustagir’s stale review via 22419ac March 15, 2024 15:31

apply phpcbf formatting

ea5e8c1

ccho-mongodb requested a review from GromNaN March 15, 2024 15:55

GromNaN approved these changes Mar 15, 2024

View reviewed changes

ccho-mongodb mentioned this pull request Mar 15, 2024

DOCSP-37057 eloquent schema builder #2776

Merged

3 tasks

GromNaN added the docs label Mar 25, 2024

GromNaN changed the base branch from 4.1 to docs-rewrite March 25, 2024 16:26

GromNaN changed the base branch from docs-rewrite to 4.1 March 25, 2024 16:59

Merge branch '4.1' into DOCSP-37056-eloquent-relationships

e7ebc47

ccho-mongodb merged commit 2117c2c into mongodb:4.1 Mar 25, 2024

ccho-mongodb deleted the DOCSP-37056-eloquent-relationships branch March 25, 2024 21:08

This was referenced Mar 25, 2024

Merge 4.1 into 4.2 #2793

Closed

Merge 4.1 into 4.2 #2794

Merged

Merge 4.2 into 4.3 #2800

Merged

jmikola pushed a commit that referenced this pull request Mar 27, 2024

DOCSP-37056 eloquent relationships (#2747)

642bd22

* DOCSP-37056: Eloquent relationships

This was referenced Apr 3, 2024

Merge 4.2 into 4.3 #2819

Closed

Merge 4.2 into 4.3 #2822

Closed

Merge 4.2 into 4.3 #2827

Closed

Merge 4.2 into 4.3 #2828

Closed

Merge 4.2 into 4.3 #2832

Closed

Merge 4.2 into 4.3 #2835

Merged

		Eloquent models are part of the Laravel Eloquent object-relational
		mapping (ORM) framework that enable you to work with a database by using

		the parent model instead of keeping foreign key references. This pattern
		when you must optimize for one or more of the following requirements:

		The following example class shows how to define a ``HasOne`` one to one
		relationship between a ``Planet`` and ``Orbit`` model.

	records of the other type.
	records of the other type and (vice versa or something like that).

		The following section shows an example of how to create a many to many
		relationship between model classes.

	and add the relationship between them. Click the :guilabel:`View Output`
	and add the relationship between them. Click the :guilabel:`View Output`

		The following example class shows how to define an ``embedsMany`` one to many
		relationship between a ``SpaceShip`` and ``Cargo`` model:

DOCSP-37056 eloquent relationships #2747

DOCSP-37056 eloquent relationships #2747

Uh oh!

Conversation

ccho-mongodb commented Mar 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ccho-mongodb Mar 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

GromNaN left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

GromNaN left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ccho-mongodb commented Mar 5, 2024 •

edited

Loading

ccho-mongodb Mar 7, 2024 •

edited

Loading